/*
 * Anything: A flexible and easy to use data structure that combines the 
 * characteristics of a list and a hashmap into one data structure.
 * 
 * Based on a paper by Peter Sommerlad and Marcel Rueedi on 
 * 'Do-it-yourself reflection' entered at EuroPLOP 1998.
 * 
 * This library was written completely from scratch and is based only 
 * in spirit on the original Java Anything implementation written by 
 * Andre Weinand/Marcel Rueedi in 1997/99 and enhanced by Stefan Tramm 
 * in 2006.
 * 
 * Copyright (c) 2008 Thomas Marti and others. All rights reserved.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package any.functor.interfaces;

public interface PredicatableFunction<FR, P, TO> extends Function<FR, TO> {

	/**
	 * ... Calling this method resets a previous predicate set 
	 * via <tt>select()</tt> or {@link #filter(Predicate)}.
	 * 
	 * 
	 * @param predicate Only elements matching this predicate will be 
	 *                  processed. Setting <tt>null</tt> will return  
	 *                  <b>all</b> elements.
	 * @return The function set with the specified selection predicate.
	 * @see #filter(Predicate)
	 */
	Function<FR, TO> select(Predicate<? super P> predicate);

	/**
	 * ... Calling this method resets a previous predicate set 
	 * via <tt>filter()</tt> or {@link #select(Predicate)}.
	 * 
	 * @param predicate All elements matching this predicate will be 
	 *                  filtered out. Setting <tt>null</tt> will result 
	 *                  in <b>no</b> filtering.
	 * @return The function set with the specified filter predicate.
	 * @see #select(Predicate)
	 */
	Function<FR, TO> filter(Predicate<? super P> predicate);
	
}
